#pragma once
/***********************************************************************************************
COPYRIGHT 2011 Mafahir Fairoze

This file is part of Neural++.
(Project Website : http://mafahir.wordpress.com/projects/neuralplusplus)

Neural++ is a free software. You can redistribute it and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation, either version 3
of the License, or (at your option) any later version.

Neural++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License <http://www.gnu.org/licenses/> for more details.

***********************************************************************************************/

namespace NeuralPlusPlus
	{
	namespace Core
		{
		namespace LearningRateFunctions
			{
			/// <summary>
			/// An abstract base class for a learning rate function.
			/// </summary>
			class AbstractFunction abstract
				{
				/// <summary>
				/// Initial Learning Rate
				/// </summary>
				public: double InitialLearningRate;

						/// <summary>
						/// Final Learning Rate
						/// </summary>
				public: double FinalLearningRate;

						/// <summary>
						/// Constructs a new instance with the specified initial and final values of learning rate.
						/// </summary>
				public: AbstractFunction(double initialLearningRate, double finalLearningRate);

						/// <summary>
						/// Gets effective learning rate for current training iteration.
						/// </summary>
				public: virtual double GetLearningRate(int currentIteration, int trainingEpochs) = 0;
				};
			}

		}
	}